SPEC就是泛指產品要被開發時的依據規範及條件,讓是全體開發人員有一個依據文件可以參照。
用一個文件管理系統做到規格敘述說明(SPEC)、編年史完整(Chronicle)和迭代(Iteration)的內容
你的產品有多好並不重要,因為如果它的文件不夠好,人們就不會使用它。即使他們因為別無選擇而必須使用它,如果沒有良好的文檔,他們也不會有效地使用它或按照您希望的方式使用它。
規格文檔,會需包含未來、現在、過去的內容,因此也需要做好版本控制,避免現在執行項目的人員,誤判仍在設計中的未來項目,有需要一並開發;也避免SQA在Q時,看到未來內容,以爲是RD未開發。
盡可能每一個規則都會有替代規則,例如讀不到資料或無資料時,要採用什麼替代圖片與提示文字。
目前看過最好的文件架構就是「The Documentation System」這一個由divio提出的模式,這文件架構,對於每一個關係人都會有想相對應的內容可以取得,也對於執行者可以有前後脈絡依據的內容的參考,而運用這個架構撰寫產品SPEC,比較有效率的將同一份內容應用不同情境,這框架有幾個特色:
每個象限與其兩個相鄰象限相似,讓每一個人從那一個象限角度開始閱讀,都可以獲得必要資訊
教學說明和操作指南將會描述描述實際步驟,以利於閱讀者理解
操作指南和技術參考主要都描述在執行任務、Coding人員時所需要的資訊內容
參考指南和解釋都會包含理論知識內容
教程和解釋在我們瞭解學習這文件內容時使用
真正的困能的是要即時更新和維護文件,必免資訊斷層,但這就是難的地方,如果體制小組織還容易同步,但如果體制大時,同步就會變得很緩慢困難。
撰寫SPEC的原則,應該保持的讓每一個都方便可以取得,並且可以易於理解內容後,執行相對應的專案的內容,因此不要把SPEC文件,當作神書在撰寫,會造成很多不必得要的紛爭。
推最後一句。
但遇過SPEC文件要寫成白皮書的聖經一樣@@
遠目那段日子~
from: 梗圖產生器
哈哈....XDDDDD
白皮書的聖經.......我怎麼背景音樂響起聖歌...哈利路亞~~